| Fully Qualified Name: | CodeIgniter\Debug\Toolbar\Collectors\Database |
| Extends: | BaseCollector |
Collector for the Database tab of the Debug Toolbar.
| Name | Description | Defined By |
|---|---|---|
| __construct() | Constructor | Database |
| cleanPath() | Clean Path | BaseCollector |
| collect() | The static method used during Events to collect data. | Database |
| display() | Returns the data of this collector to be formatted in the toolbar | Database |
| getAsArray() | Return settings as an array. | BaseCollector |
| getBadgeValue() | Gets the "badge" value for the button. | Database |
| getTitle() | Gets the Collector's title. | BaseCollector |
| getTitleDetails() | Information to be displayed next to the title. | Database |
| getVarData() | Gets a collection of data that should be shown in the 'Vars' tab. | BaseCollector |
| hasLabel() | Does this collector have a label? | BaseCollector |
| hasTabContent() | Does this collector need it's own tab? | BaseCollector |
| hasTimelineData() | Does this collector have information for the timeline? | BaseCollector |
| hasVarData() | Does this Collector have data that should be shown in the 'Vars' tab? | BaseCollector |
| icon() | Display the icon. | Database |
| isEmpty() | Does this collector have any data collected? | Database |
| timelineData() | Grabs the data for the timeline, properly formatted, or returns an empty array. | BaseCollector |
Constructor
Returns:
Clean Path
This makes nicer looking paths for the error output.
| Parameter Name | Type | Description |
|---|---|---|
| $file | string |
Returns: string
The static method used during Events to collect data.
| Parameter Name | Type | Description |
|---|---|---|
| $query | \CodeIgniter\Database\Query |
Returns:
Returns the data of this collector to be formatted in the toolbar
Returns: array
Return settings as an array.
Returns: array
Gets the "badge" value for the button.
Returns: int
Gets the Collector's title.
| Parameter Name | Type | Description |
|---|---|---|
| $safe | bool |
Returns: string
Information to be displayed next to the title.
Returns: string The number of queries (in parentheses) or an empty string.
Gets a collection of data that should be shown in the 'Vars' tab.
The format is an array of sections, each with their own array of key/value pairs:
$data = [
'section 1' => [
'foo' => 'bar,
'bar' => 'baz'
],
'section 2' => [
'foo' => 'bar,
'bar' => 'baz'
],
];
Returns: null
Does this collector have a label?
Returns: bool
Does this collector need it's own tab?
Returns: bool
Does this collector have information for the timeline?
Returns: bool
Does this Collector have data that should be shown in the 'Vars' tab?
Returns: bool
Display the icon.
Icon from https://icons8.com - 1em package
Returns: string
Does this collector have any data collected?
Returns: bool
Grabs the data for the timeline, properly formatted, or returns an empty array.
Returns: array